docs(examples): add benchSDK example benchmarks - #308
Open
dtice25 wants to merge 2 commits into
Open
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor License AgreementAll contributors are covered by a CLA. |
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a self-contained
benchmarks/examples/directory with runnable.bench.tsfiles that demonstrate core@benchsdk/runnerpatterns without requiring real provider credentials. Each example uses a tinyNoopParticipanthelper that simulates create/run/destroy so the files can be exercised against any benchmarks-platform endpoint.What's added
benchmarks/examples/participants.ts— mock provider factory implementingBaseParticipantwithcreateCompute().sandbox.create().00-hello-world.bench.ts— single participant,step/measure/logbasics.01-multiple-providers.bench.ts— same task against multiple providers,--providerfiltering.02-phases.bench.ts— orderedphaseswithctx.phaseand per-phase iteration counts.03-round-robin.bench.ts—groupBy: 'round'interleaving.04-shapes.bench.ts— namedshapesvariants selected via--shape.benchmarks/examples/README.md— build/run instructions and expected CLI output.tsconfig.json— includesbenchmarks/examples/**/*.tssopnpm typecheckcovers the new files.Running an example
pnpm -r --filter "./packages/**" build bench run benchmarks/examples/00-hello-world.bench.ts --iterations 3All examples passed
pnpm typecheck.Link to Devin session: https://app.devin.ai/sessions/770c96fe577f4323ae5d7f8ca8b785dc
Requested by: @dtice25